| Junio C Hamano | b5e079f | 2013-02-08 00:02:52 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| 2 | "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| 4 | <head> |
| 5 | <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> |
| 6 | <meta name="generator" content="AsciiDoc 8.6.8" /> |
| 7 | <title>gitremote-helpers(1)</title> |
| 8 | <style type="text/css"> |
| 9 | /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ |
| 10 | |
| 11 | /* Default font. */ |
| 12 | body { |
| 13 | font-family: Georgia,serif; |
| 14 | } |
| 15 | |
| 16 | /* Title font. */ |
| 17 | h1, h2, h3, h4, h5, h6, |
| 18 | div.title, caption.title, |
| 19 | thead, p.table.header, |
| 20 | #toctitle, |
| 21 | #author, #revnumber, #revdate, #revremark, |
| 22 | #footer { |
| 23 | font-family: Arial,Helvetica,sans-serif; |
| 24 | } |
| 25 | |
| 26 | body { |
| 27 | margin: 1em 5% 1em 5%; |
| 28 | } |
| 29 | |
| 30 | a { |
| 31 | color: blue; |
| 32 | text-decoration: underline; |
| 33 | } |
| 34 | a:visited { |
| 35 | color: fuchsia; |
| 36 | } |
| 37 | |
| 38 | em { |
| 39 | font-style: italic; |
| 40 | color: navy; |
| 41 | } |
| 42 | |
| 43 | strong { |
| 44 | font-weight: bold; |
| 45 | color: #083194; |
| 46 | } |
| 47 | |
| 48 | h1, h2, h3, h4, h5, h6 { |
| 49 | color: #527bbd; |
| 50 | margin-top: 1.2em; |
| 51 | margin-bottom: 0.5em; |
| 52 | line-height: 1.3; |
| 53 | } |
| 54 | |
| 55 | h1, h2, h3 { |
| 56 | border-bottom: 2px solid silver; |
| 57 | } |
| 58 | h2 { |
| 59 | padding-top: 0.5em; |
| 60 | } |
| 61 | h3 { |
| 62 | float: left; |
| 63 | } |
| 64 | h3 + * { |
| 65 | clear: left; |
| 66 | } |
| 67 | h5 { |
| 68 | font-size: 1.0em; |
| 69 | } |
| 70 | |
| 71 | div.sectionbody { |
| 72 | margin-left: 0; |
| 73 | } |
| 74 | |
| 75 | hr { |
| 76 | border: 1px solid silver; |
| 77 | } |
| 78 | |
| 79 | p { |
| 80 | margin-top: 0.5em; |
| 81 | margin-bottom: 0.5em; |
| 82 | } |
| 83 | |
| 84 | ul, ol, li > p { |
| 85 | margin-top: 0; |
| 86 | } |
| 87 | ul > li { color: #aaa; } |
| 88 | ul > li > * { color: black; } |
| 89 | |
| 90 | .monospaced, code, pre { |
| 91 | font-family: "Courier New", Courier, monospace; |
| 92 | font-size: inherit; |
| 93 | color: navy; |
| 94 | padding: 0; |
| 95 | margin: 0; |
| 96 | } |
| 97 | |
| 98 | |
| 99 | #author { |
| 100 | color: #527bbd; |
| 101 | font-weight: bold; |
| 102 | font-size: 1.1em; |
| 103 | } |
| 104 | #email { |
| 105 | } |
| 106 | #revnumber, #revdate, #revremark { |
| 107 | } |
| 108 | |
| 109 | #footer { |
| 110 | font-size: small; |
| 111 | border-top: 2px solid silver; |
| 112 | padding-top: 0.5em; |
| 113 | margin-top: 4.0em; |
| 114 | } |
| 115 | #footer-text { |
| 116 | float: left; |
| 117 | padding-bottom: 0.5em; |
| 118 | } |
| 119 | #footer-badges { |
| 120 | float: right; |
| 121 | padding-bottom: 0.5em; |
| 122 | } |
| 123 | |
| 124 | #preamble { |
| 125 | margin-top: 1.5em; |
| 126 | margin-bottom: 1.5em; |
| 127 | } |
| 128 | div.imageblock, div.exampleblock, div.verseblock, |
| 129 | div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, |
| 130 | div.admonitionblock { |
| 131 | margin-top: 1.0em; |
| 132 | margin-bottom: 1.5em; |
| 133 | } |
| 134 | div.admonitionblock { |
| 135 | margin-top: 2.0em; |
| 136 | margin-bottom: 2.0em; |
| 137 | margin-right: 10%; |
| 138 | color: #606060; |
| 139 | } |
| 140 | |
| 141 | div.content { /* Block element content. */ |
| 142 | padding: 0; |
| 143 | } |
| 144 | |
| 145 | /* Block element titles. */ |
| 146 | div.title, caption.title { |
| 147 | color: #527bbd; |
| 148 | font-weight: bold; |
| 149 | text-align: left; |
| 150 | margin-top: 1.0em; |
| 151 | margin-bottom: 0.5em; |
| 152 | } |
| 153 | div.title + * { |
| 154 | margin-top: 0; |
| 155 | } |
| 156 | |
| 157 | td div.title:first-child { |
| 158 | margin-top: 0.0em; |
| 159 | } |
| 160 | div.content div.title:first-child { |
| 161 | margin-top: 0.0em; |
| 162 | } |
| 163 | div.content + div.title { |
| 164 | margin-top: 0.0em; |
| 165 | } |
| 166 | |
| 167 | div.sidebarblock > div.content { |
| 168 | background: #ffffee; |
| 169 | border: 1px solid #dddddd; |
| 170 | border-left: 4px solid #f0f0f0; |
| 171 | padding: 0.5em; |
| 172 | } |
| 173 | |
| 174 | div.listingblock > div.content { |
| 175 | border: 1px solid #dddddd; |
| 176 | border-left: 5px solid #f0f0f0; |
| 177 | background: #f8f8f8; |
| 178 | padding: 0.5em; |
| 179 | } |
| 180 | |
| 181 | div.quoteblock, div.verseblock { |
| 182 | padding-left: 1.0em; |
| 183 | margin-left: 1.0em; |
| 184 | margin-right: 10%; |
| 185 | border-left: 5px solid #f0f0f0; |
| 186 | color: #888; |
| 187 | } |
| 188 | |
| 189 | div.quoteblock > div.attribution { |
| 190 | padding-top: 0.5em; |
| 191 | text-align: right; |
| 192 | } |
| 193 | |
| 194 | div.verseblock > pre.content { |
| 195 | font-family: inherit; |
| 196 | font-size: inherit; |
| 197 | } |
| 198 | div.verseblock > div.attribution { |
| 199 | padding-top: 0.75em; |
| 200 | text-align: left; |
| 201 | } |
| 202 | /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ |
| 203 | div.verseblock + div.attribution { |
| 204 | text-align: left; |
| 205 | } |
| 206 | |
| 207 | div.admonitionblock .icon { |
| 208 | vertical-align: top; |
| 209 | font-size: 1.1em; |
| 210 | font-weight: bold; |
| 211 | text-decoration: underline; |
| 212 | color: #527bbd; |
| 213 | padding-right: 0.5em; |
| 214 | } |
| 215 | div.admonitionblock td.content { |
| 216 | padding-left: 0.5em; |
| 217 | border-left: 3px solid #dddddd; |
| 218 | } |
| 219 | |
| 220 | div.exampleblock > div.content { |
| 221 | border-left: 3px solid #dddddd; |
| 222 | padding-left: 0.5em; |
| 223 | } |
| 224 | |
| 225 | div.imageblock div.content { padding-left: 0; } |
| 226 | span.image img { border-style: none; } |
| 227 | a.image:visited { color: white; } |
| 228 | |
| 229 | dl { |
| 230 | margin-top: 0.8em; |
| 231 | margin-bottom: 0.8em; |
| 232 | } |
| 233 | dt { |
| 234 | margin-top: 0.5em; |
| 235 | margin-bottom: 0; |
| 236 | font-style: normal; |
| 237 | color: navy; |
| 238 | } |
| 239 | dd > *:first-child { |
| 240 | margin-top: 0.1em; |
| 241 | } |
| 242 | |
| 243 | ul, ol { |
| 244 | list-style-position: outside; |
| 245 | } |
| 246 | ol.arabic { |
| 247 | list-style-type: decimal; |
| 248 | } |
| 249 | ol.loweralpha { |
| 250 | list-style-type: lower-alpha; |
| 251 | } |
| 252 | ol.upperalpha { |
| 253 | list-style-type: upper-alpha; |
| 254 | } |
| 255 | ol.lowerroman { |
| 256 | list-style-type: lower-roman; |
| 257 | } |
| 258 | ol.upperroman { |
| 259 | list-style-type: upper-roman; |
| 260 | } |
| 261 | |
| 262 | div.compact ul, div.compact ol, |
| 263 | div.compact p, div.compact p, |
| 264 | div.compact div, div.compact div { |
| 265 | margin-top: 0.1em; |
| 266 | margin-bottom: 0.1em; |
| 267 | } |
| 268 | |
| 269 | tfoot { |
| 270 | font-weight: bold; |
| 271 | } |
| 272 | td > div.verse { |
| 273 | white-space: pre; |
| 274 | } |
| 275 | |
| 276 | div.hdlist { |
| 277 | margin-top: 0.8em; |
| 278 | margin-bottom: 0.8em; |
| 279 | } |
| 280 | div.hdlist tr { |
| 281 | padding-bottom: 15px; |
| 282 | } |
| 283 | dt.hdlist1.strong, td.hdlist1.strong { |
| 284 | font-weight: bold; |
| 285 | } |
| 286 | td.hdlist1 { |
| 287 | vertical-align: top; |
| 288 | font-style: normal; |
| 289 | padding-right: 0.8em; |
| 290 | color: navy; |
| 291 | } |
| 292 | td.hdlist2 { |
| 293 | vertical-align: top; |
| 294 | } |
| 295 | div.hdlist.compact tr { |
| 296 | margin: 0; |
| 297 | padding-bottom: 0; |
| 298 | } |
| 299 | |
| 300 | .comment { |
| 301 | background: yellow; |
| 302 | } |
| 303 | |
| 304 | .footnote, .footnoteref { |
| 305 | font-size: 0.8em; |
| 306 | } |
| 307 | |
| 308 | span.footnote, span.footnoteref { |
| 309 | vertical-align: super; |
| 310 | } |
| 311 | |
| 312 | #footnotes { |
| 313 | margin: 20px 0 20px 0; |
| 314 | padding: 7px 0 0 0; |
| 315 | } |
| 316 | |
| 317 | #footnotes div.footnote { |
| 318 | margin: 0 0 5px 0; |
| 319 | } |
| 320 | |
| 321 | #footnotes hr { |
| 322 | border: none; |
| 323 | border-top: 1px solid silver; |
| 324 | height: 1px; |
| 325 | text-align: left; |
| 326 | margin-left: 0; |
| 327 | width: 20%; |
| 328 | min-width: 100px; |
| 329 | } |
| 330 | |
| 331 | div.colist td { |
| 332 | padding-right: 0.5em; |
| 333 | padding-bottom: 0.3em; |
| 334 | vertical-align: top; |
| 335 | } |
| 336 | div.colist td img { |
| 337 | margin-top: 0.3em; |
| 338 | } |
| 339 | |
| 340 | @media print { |
| 341 | #footer-badges { display: none; } |
| 342 | } |
| 343 | |
| 344 | #toc { |
| 345 | margin-bottom: 2.5em; |
| 346 | } |
| 347 | |
| 348 | #toctitle { |
| 349 | color: #527bbd; |
| 350 | font-size: 1.1em; |
| 351 | font-weight: bold; |
| 352 | margin-top: 1.0em; |
| 353 | margin-bottom: 0.1em; |
| 354 | } |
| 355 | |
| 356 | div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { |
| 357 | margin-top: 0; |
| 358 | margin-bottom: 0; |
| 359 | } |
| 360 | div.toclevel2 { |
| 361 | margin-left: 2em; |
| 362 | font-size: 0.9em; |
| 363 | } |
| 364 | div.toclevel3 { |
| 365 | margin-left: 4em; |
| 366 | font-size: 0.9em; |
| 367 | } |
| 368 | div.toclevel4 { |
| 369 | margin-left: 6em; |
| 370 | font-size: 0.9em; |
| 371 | } |
| 372 | |
| 373 | span.aqua { color: aqua; } |
| 374 | span.black { color: black; } |
| 375 | span.blue { color: blue; } |
| 376 | span.fuchsia { color: fuchsia; } |
| 377 | span.gray { color: gray; } |
| 378 | span.green { color: green; } |
| 379 | span.lime { color: lime; } |
| 380 | span.maroon { color: maroon; } |
| 381 | span.navy { color: navy; } |
| 382 | span.olive { color: olive; } |
| 383 | span.purple { color: purple; } |
| 384 | span.red { color: red; } |
| 385 | span.silver { color: silver; } |
| 386 | span.teal { color: teal; } |
| 387 | span.white { color: white; } |
| 388 | span.yellow { color: yellow; } |
| 389 | |
| 390 | span.aqua-background { background: aqua; } |
| 391 | span.black-background { background: black; } |
| 392 | span.blue-background { background: blue; } |
| 393 | span.fuchsia-background { background: fuchsia; } |
| 394 | span.gray-background { background: gray; } |
| 395 | span.green-background { background: green; } |
| 396 | span.lime-background { background: lime; } |
| 397 | span.maroon-background { background: maroon; } |
| 398 | span.navy-background { background: navy; } |
| 399 | span.olive-background { background: olive; } |
| 400 | span.purple-background { background: purple; } |
| 401 | span.red-background { background: red; } |
| 402 | span.silver-background { background: silver; } |
| 403 | span.teal-background { background: teal; } |
| 404 | span.white-background { background: white; } |
| 405 | span.yellow-background { background: yellow; } |
| 406 | |
| 407 | span.big { font-size: 2em; } |
| 408 | span.small { font-size: 0.6em; } |
| 409 | |
| 410 | span.underline { text-decoration: underline; } |
| 411 | span.overline { text-decoration: overline; } |
| 412 | span.line-through { text-decoration: line-through; } |
| 413 | |
| 414 | div.unbreakable { page-break-inside: avoid; } |
| 415 | |
| 416 | |
| 417 | /* |
| 418 | * xhtml11 specific |
| 419 | * |
| 420 | * */ |
| 421 | |
| 422 | div.tableblock { |
| 423 | margin-top: 1.0em; |
| 424 | margin-bottom: 1.5em; |
| 425 | } |
| 426 | div.tableblock > table { |
| 427 | border: 3px solid #527bbd; |
| 428 | } |
| 429 | thead, p.table.header { |
| 430 | font-weight: bold; |
| 431 | color: #527bbd; |
| 432 | } |
| 433 | p.table { |
| 434 | margin-top: 0; |
| 435 | } |
| 436 | /* Because the table frame attribute is overriden by CSS in most browsers. */ |
| 437 | div.tableblock > table[frame="void"] { |
| 438 | border-style: none; |
| 439 | } |
| 440 | div.tableblock > table[frame="hsides"] { |
| 441 | border-left-style: none; |
| 442 | border-right-style: none; |
| 443 | } |
| 444 | div.tableblock > table[frame="vsides"] { |
| 445 | border-top-style: none; |
| 446 | border-bottom-style: none; |
| 447 | } |
| 448 | |
| 449 | |
| 450 | /* |
| 451 | * html5 specific |
| 452 | * |
| 453 | * */ |
| 454 | |
| 455 | table.tableblock { |
| 456 | margin-top: 1.0em; |
| 457 | margin-bottom: 1.5em; |
| 458 | } |
| 459 | thead, p.tableblock.header { |
| 460 | font-weight: bold; |
| 461 | color: #527bbd; |
| 462 | } |
| 463 | p.tableblock { |
| 464 | margin-top: 0; |
| 465 | } |
| 466 | table.tableblock { |
| 467 | border-width: 3px; |
| 468 | border-spacing: 0px; |
| 469 | border-style: solid; |
| 470 | border-color: #527bbd; |
| 471 | border-collapse: collapse; |
| 472 | } |
| 473 | th.tableblock, td.tableblock { |
| 474 | border-width: 1px; |
| 475 | padding: 4px; |
| 476 | border-style: solid; |
| 477 | border-color: #527bbd; |
| 478 | } |
| 479 | |
| 480 | table.tableblock.frame-topbot { |
| 481 | border-left-style: hidden; |
| 482 | border-right-style: hidden; |
| 483 | } |
| 484 | table.tableblock.frame-sides { |
| 485 | border-top-style: hidden; |
| 486 | border-bottom-style: hidden; |
| 487 | } |
| 488 | table.tableblock.frame-none { |
| 489 | border-style: hidden; |
| 490 | } |
| 491 | |
| 492 | th.tableblock.halign-left, td.tableblock.halign-left { |
| 493 | text-align: left; |
| 494 | } |
| 495 | th.tableblock.halign-center, td.tableblock.halign-center { |
| 496 | text-align: center; |
| 497 | } |
| 498 | th.tableblock.halign-right, td.tableblock.halign-right { |
| 499 | text-align: right; |
| 500 | } |
| 501 | |
| 502 | th.tableblock.valign-top, td.tableblock.valign-top { |
| 503 | vertical-align: top; |
| 504 | } |
| 505 | th.tableblock.valign-middle, td.tableblock.valign-middle { |
| 506 | vertical-align: middle; |
| 507 | } |
| 508 | th.tableblock.valign-bottom, td.tableblock.valign-bottom { |
| 509 | vertical-align: bottom; |
| 510 | } |
| 511 | |
| 512 | |
| 513 | /* |
| 514 | * manpage specific |
| 515 | * |
| 516 | * */ |
| 517 | |
| 518 | body.manpage h1 { |
| 519 | padding-top: 0.5em; |
| 520 | padding-bottom: 0.5em; |
| 521 | border-top: 2px solid silver; |
| 522 | border-bottom: 2px solid silver; |
| 523 | } |
| 524 | body.manpage h2 { |
| 525 | border-style: none; |
| 526 | } |
| 527 | body.manpage div.sectionbody { |
| 528 | margin-left: 3em; |
| 529 | } |
| 530 | |
| 531 | @media print { |
| 532 | body.manpage div#toc { display: none; } |
| 533 | } |
| 534 | |
| 535 | |
| 536 | </style> |
| 537 | <script type="text/javascript"> |
| 538 | /*<+'])'); |
| 581 | // Function that scans the DOM tree for header elements (the DOM2 |
| 582 | // nodeIterator API would be a better technique but not supported by all |
| 583 | // browsers). |
| 584 | var iterate = function (el) { |
| 585 | for (var i = el.firstChild; i != null; i = i.nextSibling) { |
| 586 | if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { |
| 587 | var mo = re.exec(i.tagName); |
| 588 | if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { |
| 589 | result[result.length] = new TocEntry(i, getText(i), mo[1]-1); |
| 590 | } |
| 591 | iterate(i); |
| 592 | } |
| 593 | } |
| 594 | } |
| 595 | iterate(el); |
| 596 | return result; |
| 597 | } |
| 598 | |
| 599 | var toc = document.getElementById("toc"); |
| 600 | if (!toc) { |
| 601 | return; |
| 602 | } |
| 603 | |
| 604 | // Delete existing TOC entries in case we're reloading the TOC. |
| 605 | var tocEntriesToRemove = []; |
| 606 | var i; |
| 607 | for (i = 0; i < toc.childNodes.length; i++) { |
| 608 | var entry = toc.childNodes[i]; |
| 609 | if (entry.nodeName.toLowerCase() == 'div' |
| 610 | && entry.getAttribute("class") |
| 611 | && entry.getAttribute("class").match(/^toclevel/)) |
| 612 | tocEntriesToRemove.push(entry); |
| 613 | } |
| 614 | for (i = 0; i < tocEntriesToRemove.length; i++) { |
| 615 | toc.removeChild(tocEntriesToRemove[i]); |
| 616 | } |
| 617 | |
| 618 | // Rebuild TOC entries. |
| 619 | var entries = tocEntries(document.getElementById("content"), toclevels); |
| 620 | for (var i = 0; i < entries.length; ++i) { |
| 621 | var entry = entries[i]; |
| 622 | if (entry.element.id == "") |
| 623 | entry.element.id = "_toc_" + i; |
| 624 | var a = document.createElement("a"); |
| 625 | a.href = "#" + entry.element.id; |
| 626 | a.appendChild(document.createTextNode(entry.text)); |
| 627 | var div = document.createElement("div"); |
| 628 | div.appendChild(a); |
| 629 | div.className = "toclevel" + entry.toclevel; |
| 630 | toc.appendChild(div); |
| 631 | } |
| 632 | if (entries.length == 0) |
| 633 | toc.parentNode.removeChild(toc); |
| 634 | }, |
| 635 | |
| 636 | |
| 637 | ///////////////////////////////////////////////////////////////////// |
| 638 | // Footnotes generator |
| 639 | ///////////////////////////////////////////////////////////////////// |
| 640 | |
| 641 | /* Based on footnote generation code from: |
| 642 | * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html |
| 643 | */ |
| 644 | |
| 645 | footnotes: function () { |
| 646 | // Delete existing footnote entries in case we're reloading the footnodes. |
| 647 | var i; |
| 648 | var noteholder = document.getElementById("footnotes"); |
| 649 | if (!noteholder) { |
| 650 | return; |
| 651 | } |
| 652 | var entriesToRemove = []; |
| 653 | for (i = 0; i < noteholder.childNodes.length; i++) { |
| 654 | var entry = noteholder.childNodes[i]; |
| 655 | if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") |
| 656 | entriesToRemove.push(entry); |
| 657 | } |
| 658 | for (i = 0; i < entriesToRemove.length; i++) { |
| 659 | noteholder.removeChild(entriesToRemove[i]); |
| 660 | } |
| 661 | |
| 662 | // Rebuild footnote entries. |
| 663 | var cont = document.getElementById("content"); |
| 664 | var spans = cont.getElementsByTagName("span"); |
| 665 | var refs = {}; |
| 666 | var n = 0; |
| 667 | for (i=0; i<spans.length; i++) { |
| 668 | if (spans[i].className == "footnote") { |
| 669 | n++; |
| 670 | var note = spans[i].getAttribute("data-note"); |
| 671 | if (!note) { |
| 672 | // Use [\s\S] in place of . so multi-line matches work. |
| 673 | // Because JavaScript has no s (dotall) regex flag. |
| 674 | note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; |
| 675 | spans[i].innerHTML = |
| 676 | "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + |
| 677 | "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 678 | spans[i].setAttribute("data-note", note); |
| 679 | } |
| 680 | noteholder.innerHTML += |
| 681 | "<div class='footnote' id='_footnote_" + n + "'>" + |
| 682 | "<a href='#_footnoteref_" + n + "' title='Return to text'>" + |
| 683 | n + "</a>. " + note + "</div>"; |
| 684 | var id =spans[i].getAttribute("id"); |
| 685 | if (id != null) refs["#"+id] = n; |
| 686 | } |
| 687 | } |
| 688 | if (n == 0) |
| 689 | noteholder.parentNode.removeChild(noteholder); |
| 690 | else { |
| 691 | // Process footnoterefs. |
| 692 | for (i=0; i<spans.length; i++) { |
| 693 | if (spans[i].className == "footnoteref") { |
| 694 | var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); |
| 695 | href = href.match(/#.*/)[0]; // Because IE return full URL. |
| 696 | n = refs[href]; |
| 697 | spans[i].innerHTML = |
| 698 | "[<a href='#_footnote_" + n + |
| 699 | "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 700 | } |
| 701 | } |
| 702 | } |
| 703 | }, |
| 704 | |
| 705 | install: function(toclevels) { |
| 706 | var timerId; |
| 707 | |
| 708 | function reinstall() { |
| 709 | asciidoc.footnotes(); |
| 710 | if (toclevels) { |
| 711 | asciidoc.toc(toclevels); |
| 712 | } |
| 713 | } |
| 714 | |
| 715 | function reinstallAndRemoveTimer() { |
| 716 | clearInterval(timerId); |
| 717 | reinstall(); |
| 718 | } |
| 719 | |
| 720 | timerId = setInterval(reinstall, 500); |
| 721 | if (document.addEventListener) |
| 722 | document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); |
| 723 | else |
| 724 | window.onload = reinstallAndRemoveTimer; |
| 725 | } |
| 726 | |
| 727 | } |
| 728 | asciidoc.install(); |
| 729 | /*]]>*/ |
| 730 | </script> |
| 731 | </head> |
| 732 | <body class="manpage"> |
| 733 | <div id="header"> |
| 734 | <h1> |
| 735 | gitremote-helpers(1) Manual Page |
| 736 | </h1> |
| 737 | <h2>NAME</h2> |
| 738 | <div class="sectionbody"> |
| 739 | <p>gitremote-helpers - |
| 740 | Helper programs to interact with remote repositories |
| 741 | </p> |
| 742 | </div> |
| 743 | </div> |
| 744 | <div id="content"> |
| 745 | <div class="sect1"> |
| 746 | <h2 id="_synopsis">SYNOPSIS</h2> |
| 747 | <div class="sectionbody"> |
| 748 | <div class="verseblock"> |
| 749 | <pre class="content"><em>git remote-<transport></em> <repository> [<URL>]</pre> |
| 750 | <div class="attribution"> |
| 751 | </div></div> |
| 752 | </div> |
| 753 | </div> |
| 754 | <div class="sect1"> |
| 755 | <h2 id="_description">DESCRIPTION</h2> |
| 756 | <div class="sectionbody"> |
| 757 | <div class="paragraph"><p>Remote helper programs are normally not used directly by end users, |
| 758 | but they are invoked by Git when it needs to interact with remote |
| 759 | repositories Git does not support natively. A given helper will |
| 760 | implement a subset of the capabilities documented here. When Git |
| 761 | needs to interact with a repository using a remote helper, it spawns |
| 762 | the helper as an independent process, sends commands to the helper’s |
| 763 | standard input, and expects results from the helper’s standard |
| 764 | output. Because a remote helper runs as an independent process from |
| 765 | Git, there is no need to re-link Git to add a new helper, nor any |
| 766 | need to link the helper with the implementation of Git.</p></div> |
| 767 | <div class="paragraph"><p>Every helper must support the "capabilities" command, which Git |
| 768 | uses to determine what other commands the helper will accept. Those |
| 769 | other commands can be used to discover and update remote refs, |
| 770 | transport objects between the object database and the remote repository, |
| 771 | and update the local object store.</p></div> |
| 772 | <div class="paragraph"><p>Git comes with a "curl" family of remote helpers, that handle various |
| 773 | transport protocols, such as <em>git-remote-http</em>, <em>git-remote-https</em>, |
| 774 | <em>git-remote-ftp</em> and <em>git-remote-ftps</em>. They implement the capabilities |
| 775 | <em>fetch</em>, <em>option</em>, and <em>push</em>.</p></div> |
| 776 | </div> |
| 777 | </div> |
| 778 | <div class="sect1"> |
| 779 | <h2 id="_invocation">INVOCATION</h2> |
| 780 | <div class="sectionbody"> |
| 781 | <div class="paragraph"><p>Remote helper programs are invoked with one or (optionally) two |
| 782 | arguments. The first argument specifies a remote repository as in Git; |
| 783 | it is either the name of a configured remote or a URL. The second |
| 784 | argument specifies a URL; it is usually of the form |
| 785 | <em><transport>://<address></em>, but any arbitrary string is possible. |
| 786 | The <em>GIT_DIR</em> environment variable is set up for the remote helper |
| 787 | and can be used to determine where to store additional data or from |
| 788 | which directory to invoke auxiliary Git commands.</p></div> |
| 789 | <div class="paragraph"><p>When Git encounters a URL of the form <em><transport>://<address></em>, where |
| 790 | <em><transport></em> is a protocol that it cannot handle natively, it |
| 791 | automatically invokes <em>git remote-<transport></em> with the full URL as |
| 792 | the second argument. If such a URL is encountered directly on the |
| 793 | command line, the first argument is the same as the second, and if it |
| 794 | is encountered in a configured remote, the first argument is the name |
| 795 | of that remote.</p></div> |
| 796 | <div class="paragraph"><p>A URL of the form <em><transport>::<address></em> explicitly instructs Git to |
| 797 | invoke <em>git remote-<transport></em> with <em><address></em> as the second |
| 798 | argument. If such a URL is encountered directly on the command line, |
| 799 | the first argument is <em><address></em>, and if it is encountered in a |
| 800 | configured remote, the first argument is the name of that remote.</p></div> |
| 801 | <div class="paragraph"><p>Additionally, when a configured remote has <em>remote.<name>.vcs</em> set to |
| 802 | <em><transport></em>, Git explicitly invokes <em>git remote-<transport></em> with |
| 803 | <em><name></em> as the first argument. If set, the second argument is |
| 804 | <em>remote.<name>.url</em>; otherwise, the second argument is omitted.</p></div> |
| 805 | </div> |
| 806 | </div> |
| 807 | <div class="sect1"> |
| 808 | <h2 id="_input_format">INPUT FORMAT</h2> |
| 809 | <div class="sectionbody"> |
| 810 | <div class="paragraph"><p>Git sends the remote helper a list of commands on standard input, one |
| 811 | per line. The first command is always the <em>capabilities</em> command, in |
| 812 | response to which the remote helper must print a list of the |
| 813 | capabilities it supports (see below) followed by a blank line. The |
| 814 | response to the capabilities command determines what commands Git uses |
| 815 | in the remainder of the command stream.</p></div> |
| 816 | <div class="paragraph"><p>The command stream is terminated by a blank line. In some cases |
| 817 | (indicated in the documentation of the relevant commands), this blank |
| 818 | line is followed by a payload in some other protocol (e.g., the pack |
| 819 | protocol), while in others it indicates the end of input.</p></div> |
| 820 | <div class="sect2"> |
| 821 | <h3 id="_capabilities">Capabilities</h3> |
| 822 | <div class="paragraph"><p>Each remote helper is expected to support only a subset of commands. |
| 823 | The operations a helper supports are declared to Git in the response |
| 824 | to the <code>capabilities</code> command (see COMMANDS, below).</p></div> |
| 825 | <div class="paragraph"><p>In the following, we list all defined capabilities and for |
| 826 | each we list which commands a helper with that capability |
| 827 | must provide.</p></div> |
| 828 | <div class="sect3"> |
| 829 | <h4 id="_capabilities_for_pushing">Capabilities for Pushing</h4> |
| 830 | <div class="dlist"><dl> |
| 831 | <dt class="hdlist1"> |
| 832 | <em>connect</em> |
| 833 | </dt> |
| 834 | <dd> |
| 835 | <p> |
| 836 | Can attempt to connect to <em>git receive-pack</em> (for pushing), |
| 837 | <em>git upload-pack</em>, etc for communication using |
| 838 | git’s native packfile protocol. This |
| 839 | requires a bidirectional, full-duplex connection. |
| 840 | </p> |
| 841 | <div class="paragraph"><p>Supported commands: <em>connect</em>.</p></div> |
| 842 | </dd> |
| 843 | <dt class="hdlist1"> |
| 844 | <em>push</em> |
| 845 | </dt> |
| 846 | <dd> |
| 847 | <p> |
| 848 | Can discover remote refs and push local commits and the |
| 849 | history leading up to them to new or existing remote refs. |
| 850 | </p> |
| 851 | <div class="paragraph"><p>Supported commands: <em>list for-push</em>, <em>push</em>.</p></div> |
| 852 | </dd> |
| 853 | <dt class="hdlist1"> |
| 854 | <em>export</em> |
| 855 | </dt> |
| 856 | <dd> |
| 857 | <p> |
| 858 | Can discover remote refs and push specified objects from a |
| 859 | fast-import stream to remote refs. |
| 860 | </p> |
| 861 | <div class="paragraph"><p>Supported commands: <em>list for-push</em>, <em>export</em>.</p></div> |
| 862 | </dd> |
| 863 | </dl></div> |
| 864 | <div class="paragraph"><p>If a helper advertises <em>connect</em>, Git will use it if possible and |
| 865 | fall back to another capability if the helper requests so when |
| 866 | connecting (see the <em>connect</em> command under COMMANDS). |
| 867 | When choosing between <em>push</em> and <em>export</em>, Git prefers <em>push</em>. |
| 868 | Other frontends may have some other order of preference.</p></div> |
| 869 | </div> |
| 870 | <div class="sect3"> |
| 871 | <h4 id="_capabilities_for_fetching">Capabilities for Fetching</h4> |
| 872 | <div class="dlist"><dl> |
| 873 | <dt class="hdlist1"> |
| 874 | <em>connect</em> |
| 875 | </dt> |
| 876 | <dd> |
| 877 | <p> |
| 878 | Can try to connect to <em>git upload-pack</em> (for fetching), |
| 879 | <em>git receive-pack</em>, etc for communication using the |
| 880 | Git’s native packfile protocol. This |
| 881 | requires a bidirectional, full-duplex connection. |
| 882 | </p> |
| 883 | <div class="paragraph"><p>Supported commands: <em>connect</em>.</p></div> |
| 884 | </dd> |
| 885 | <dt class="hdlist1"> |
| 886 | <em>fetch</em> |
| 887 | </dt> |
| 888 | <dd> |
| 889 | <p> |
| 890 | Can discover remote refs and transfer objects reachable from |
| 891 | them to the local object store. |
| 892 | </p> |
| 893 | <div class="paragraph"><p>Supported commands: <em>list</em>, <em>fetch</em>.</p></div> |
| 894 | </dd> |
| 895 | <dt class="hdlist1"> |
| 896 | <em>import</em> |
| 897 | </dt> |
| 898 | <dd> |
| 899 | <p> |
| 900 | Can discover remote refs and output objects reachable from |
| 901 | them as a stream in fast-import format. |
| 902 | </p> |
| 903 | <div class="paragraph"><p>Supported commands: <em>list</em>, <em>import</em>.</p></div> |
| 904 | </dd> |
| 905 | </dl></div> |
| 906 | <div class="paragraph"><p>If a helper advertises <em>connect</em>, Git will use it if possible and |
| 907 | fall back to another capability if the helper requests so when |
| 908 | connecting (see the <em>connect</em> command under COMMANDS). |
| 909 | When choosing between <em>fetch</em> and <em>import</em>, Git prefers <em>fetch</em>. |
| 910 | Other frontends may have some other order of preference.</p></div> |
| 911 | </div> |
| 912 | <div class="sect3"> |
| 913 | <h4 id="_miscellaneous_capabilities">Miscellaneous capabilities</h4> |
| 914 | <div class="dlist"><dl> |
| 915 | <dt class="hdlist1"> |
| 916 | <em>option</em> |
| 917 | </dt> |
| 918 | <dd> |
| 919 | <p> |
| 920 | For specifying settings like <code>verbosity</code> (how much output to |
| 921 | write to stderr) and <code>depth</code> (how much history is wanted in the |
| 922 | case of a shallow clone) that affect how other commands are |
| 923 | carried out. |
| 924 | </p> |
| 925 | </dd> |
| 926 | <dt class="hdlist1"> |
| 927 | <em>refspec</em> <refspec> |
| 928 | </dt> |
| 929 | <dd> |
| 930 | <p> |
| Junio C Hamano | c710296 | 2013-05-29 23:57:17 | [diff] [blame] | 931 | For remote helpers that implement <em>import</em> or <em>export</em>, this capability |
| 932 | allows the refs to be constrained to a private namespace, instead of |
| 933 | writing to refs/heads or refs/remotes directly. |
| Junio C Hamano | b5e079f | 2013-02-08 00:02:52 | [diff] [blame] | 934 | It is recommended that all importers providing the <em>import</em> |
| Junio C Hamano | c710296 | 2013-05-29 23:57:17 | [diff] [blame] | 935 | capability use this. It’s mandatory for <em>export</em>. |
| Junio C Hamano | b5e079f | 2013-02-08 00:02:52 | [diff] [blame] | 936 | </p> |
| 937 | <div class="paragraph"><p>A helper advertising the capability |
| 938 | <code>refspec refs/heads/*:refs/svn/origin/branches/*</code> |
| 939 | is saying that, when it is asked to <code>import refs/heads/topic</code>, the |
| 940 | stream it outputs will update the <code>refs/svn/origin/branches/topic</code> |
| 941 | ref.</p></div> |
| 942 | <div class="paragraph"><p>This capability can be advertised multiple times. The first |
| 943 | applicable refspec takes precedence. The left-hand of refspecs |
| 944 | advertised with this capability must cover all refs reported by |
| Junio C Hamano | c710296 | 2013-05-29 23:57:17 | [diff] [blame] | 945 | the list command. If no <em>refspec</em> capability is advertised, |
| 946 | there is an implied <code>refspec *:*</code>.</p></div> |
| Junio C Hamano | b5e079f | 2013-02-08 00:02:52 | [diff] [blame] | 947 | </dd> |
| 948 | <dt class="hdlist1"> |
| 949 | <em>bidi-import</em> |
| 950 | </dt> |
| 951 | <dd> |
| 952 | <p> |
| 953 | This modifies the <em>import</em> capability. |
| 954 | The fast-import commands <em>cat-blob</em> and <em>ls</em> can be used by remote-helpers |
| 955 | to retrieve information about blobs and trees that already exist in |
| 956 | fast-import’s memory. This requires a channel from fast-import to the |
| 957 | remote-helper. |
| 958 | If it is advertised in addition to "import", Git establishes a pipe from |
| 959 | fast-import to the remote-helper’s stdin. |
| 960 | It follows that Git and fast-import are both connected to the |
| 961 | remote-helper’s stdin. Because Git can send multiple commands to |
| 962 | the remote-helper it is required that helpers that use <em>bidi-import</em> |
| 963 | buffer all <em>import</em> commands of a batch before sending data to fast-import. |
| 964 | This is to prevent mixing commands and fast-import responses on the |
| 965 | helper’s stdin. |
| 966 | </p> |
| 967 | </dd> |
| 968 | <dt class="hdlist1"> |
| 969 | <em>export-marks</em> <file> |
| 970 | </dt> |
| 971 | <dd> |
| 972 | <p> |
| 973 | This modifies the <em>export</em> capability, instructing Git to dump the |
| 974 | internal marks table to <file> when complete. For details, |
| 975 | read up on <em>--export-marks=<file></em> in <a href="git-fast-export.html">git-fast-export(1)</a>. |
| 976 | </p> |
| 977 | </dd> |
| 978 | <dt class="hdlist1"> |
| 979 | <em>import-marks</em> <file> |
| 980 | </dt> |
| 981 | <dd> |
| 982 | <p> |
| 983 | This modifies the <em>export</em> capability, instructing Git to load the |
| 984 | marks specified in <file> before processing any input. For details, |
| 985 | read up on <em>--import-marks=<file></em> in <a href="git-fast-export.html">git-fast-export(1)</a>. |
| 986 | </p> |
| 987 | </dd> |
| Junio C Hamano | ac002b6 | 2013-04-25 01:02:58 | [diff] [blame] | 988 | <dt class="hdlist1"> |
| 989 | <em>signed-tags</em> |
| 990 | </dt> |
| 991 | <dd> |
| 992 | <p> |
| 993 | This modifies the <em>export</em> capability, instructing Git to pass |
| 994 | <em>--signed-tags=verbatim</em> to <a href="git-fast-export.html">git-fast-export(1)</a>. In the |
| 995 | absence of this capability, Git will use <em>--signed-tags=warn-strip</em>. |
| 996 | </p> |
| 997 | </dd> |
| Junio C Hamano | b5e079f | 2013-02-08 00:02:52 | [diff] [blame] | 998 | </dl></div> |
| 999 | </div> |
| 1000 | </div> |
| 1001 | </div> |
| 1002 | </div> |
| 1003 | <div class="sect1"> |
| 1004 | <h2 id="_commands">COMMANDS</h2> |
| 1005 | <div class="sectionbody"> |
| 1006 | <div class="paragraph"><p>Commands are given by the caller on the helper’s standard input, one per line.</p></div> |
| 1007 | <div class="dlist"><dl> |
| 1008 | <dt class="hdlist1"> |
| 1009 | <em>capabilities</em> |
| 1010 | </dt> |
| 1011 | <dd> |
| 1012 | <p> |
| 1013 | Lists the capabilities of the helper, one per line, ending |
| 1014 | with a blank line. Each capability may be preceded with <em>*</em>, |
| 1015 | which marks them mandatory for Git versions using the remote |
| 1016 | helper to understand. Any unknown mandatory capability is a |
| 1017 | fatal error. |
| 1018 | </p> |
| 1019 | <div class="paragraph"><p>Support for this command is mandatory.</p></div> |
| 1020 | </dd> |
| 1021 | <dt class="hdlist1"> |
| 1022 | <em>list</em> |
| 1023 | </dt> |
| 1024 | <dd> |
| 1025 | <p> |
| 1026 | Lists the refs, one per line, in the format "<value> <name> |
| 1027 | [<attr> …]". The value may be a hex sha1 hash, "@<dest>" for |
| 1028 | a symref, or "?" to indicate that the helper could not get the |
| 1029 | value of the ref. A space-separated list of attributes follows |
| 1030 | the name; unrecognized attributes are ignored. The list ends |
| 1031 | with a blank line. |
| 1032 | </p> |
| 1033 | <div class="paragraph"><p>See REF LIST ATTRIBUTES for a list of currently defined attributes.</p></div> |
| 1034 | <div class="paragraph"><p>Supported if the helper has the "fetch" or "import" capability.</p></div> |
| 1035 | </dd> |
| 1036 | <dt class="hdlist1"> |
| 1037 | <em>list for-push</em> |
| 1038 | </dt> |
| 1039 | <dd> |
| 1040 | <p> |
| 1041 | Similar to <em>list</em>, except that it is used if and only if |
| 1042 | the caller wants to the resulting ref list to prepare |
| 1043 | push commands. |
| 1044 | A helper supporting both push and fetch can use this |
| 1045 | to distinguish for which operation the output of <em>list</em> |
| 1046 | is going to be used, possibly reducing the amount |
| 1047 | of work that needs to be performed. |
| 1048 | </p> |
| 1049 | <div class="paragraph"><p>Supported if the helper has the "push" or "export" capability.</p></div> |
| 1050 | </dd> |
| 1051 | <dt class="hdlist1"> |
| 1052 | <em>option</em> <name> <value> |
| 1053 | </dt> |
| 1054 | <dd> |
| 1055 | <p> |
| 1056 | Sets the transport helper option <name> to <value>. Outputs a |
| 1057 | single line containing one of <em>ok</em> (option successfully set), |
| 1058 | <em>unsupported</em> (option not recognized) or <em>error <msg></em> |
| 1059 | (option <name> is supported but <value> is not valid |
| 1060 | for it). Options should be set before other commands, |
| 1061 | and may influence the behavior of those commands. |
| 1062 | </p> |
| 1063 | <div class="paragraph"><p>See OPTIONS for a list of currently defined options.</p></div> |
| 1064 | <div class="paragraph"><p>Supported if the helper has the "option" capability.</p></div> |
| 1065 | </dd> |
| 1066 | <dt class="hdlist1"> |
| 1067 | <em>fetch</em> <sha1> <name> |
| 1068 | </dt> |
| 1069 | <dd> |
| 1070 | <p> |
| 1071 | Fetches the given object, writing the necessary objects |
| 1072 | to the database. Fetch commands are sent in a batch, one |
| 1073 | per line, terminated with a blank line. |
| 1074 | Outputs a single blank line when all fetch commands in the |
| 1075 | same batch are complete. Only objects which were reported |
| 1076 | in the output of <em>list</em> with a sha1 may be fetched this way. |
| 1077 | </p> |
| 1078 | <div class="paragraph"><p>Optionally may output a <em>lock <file></em> line indicating a file under |
| 1079 | GIT_DIR/objects/pack which is keeping a pack until refs can be |
| 1080 | suitably updated.</p></div> |
| 1081 | <div class="paragraph"><p>Supported if the helper has the "fetch" capability.</p></div> |
| 1082 | </dd> |
| 1083 | <dt class="hdlist1"> |
| 1084 | <em>push</em> +<src>:<dst> |
| 1085 | </dt> |
| 1086 | <dd> |
| 1087 | <p> |
| 1088 | Pushes the given local <src> commit or branch to the |
| 1089 | remote branch described by <dst>. A batch sequence of |
| 1090 | one or more <em>push</em> commands is terminated with a blank line |
| 1091 | (if there is only one reference to push, a single <em>push</em> command |
| 1092 | is followed by a blank line). For example, the following would |
| 1093 | be two batches of <em>push</em>, the first asking the remote-helper |
| 1094 | to push the local ref <em>master</em> to the remote ref <em>master</em> and |
| 1095 | the local <em>HEAD</em> to the remote <em>branch</em>, and the second |
| 1096 | asking to push ref <em>foo</em> to ref <em>bar</em> (forced update requested |
| 1097 | by the <em>+</em>). |
| 1098 | </p> |
| 1099 | <div class="listingblock"> |
| 1100 | <div class="content"> |
| 1101 | <pre><code>push refs/heads/master:refs/heads/master |
| 1102 | push HEAD:refs/heads/branch |
| 1103 | \n |
| 1104 | push +refs/heads/foo:refs/heads/bar |
| 1105 | \n</code></pre> |
| 1106 | </div></div> |
| 1107 | <div class="paragraph"><p>Zero or more protocol options may be entered after the last <em>push</em> |
| 1108 | command, before the batch’s terminating blank line.</p></div> |
| 1109 | <div class="paragraph"><p>When the push is complete, outputs one or more <em>ok <dst></em> or |
| 1110 | <em>error <dst> <why>?</em> lines to indicate success or failure of |
| 1111 | each pushed ref. The status report output is terminated by |
| 1112 | a blank line. The option field <why> may be quoted in a C |
| 1113 | style string if it contains an LF.</p></div> |
| 1114 | <div class="paragraph"><p>Supported if the helper has the "push" capability.</p></div> |
| 1115 | </dd> |
| 1116 | <dt class="hdlist1"> |
| 1117 | <em>import</em> <name> |
| 1118 | </dt> |
| 1119 | <dd> |
| 1120 | <p> |
| 1121 | Produces a fast-import stream which imports the current value |
| 1122 | of the named ref. It may additionally import other refs as |
| 1123 | needed to construct the history efficiently. The script writes |
| 1124 | to a helper-specific private namespace. The value of the named |
| 1125 | ref should be written to a location in this namespace derived |
| 1126 | by applying the refspecs from the "refspec" capability to the |
| 1127 | name of the ref. |
| 1128 | </p> |
| 1129 | <div class="paragraph"><p>Especially useful for interoperability with a foreign versioning |
| 1130 | system.</p></div> |
| 1131 | <div class="paragraph"><p>Just like <em>push</em>, a batch sequence of one or more <em>import</em> is |
| 1132 | terminated with a blank line. For each batch of <em>import</em>, the remote |
| 1133 | helper should produce a fast-import stream terminated by a <em>done</em> |
| 1134 | command.</p></div> |
| 1135 | <div class="paragraph"><p>Note that if the <em>bidi-import</em> capability is used the complete batch |
| 1136 | sequence has to be buffered before starting to send data to fast-import |
| 1137 | to prevent mixing of commands and fast-import responses on the helper’s |
| 1138 | stdin.</p></div> |
| 1139 | <div class="paragraph"><p>Supported if the helper has the "import" capability.</p></div> |
| 1140 | </dd> |
| 1141 | <dt class="hdlist1"> |
| 1142 | <em>export</em> |
| 1143 | </dt> |
| 1144 | <dd> |
| 1145 | <p> |
| 1146 | Instructs the remote helper that any subsequent input is |
| 1147 | part of a fast-import stream (generated by <em>git fast-export</em>) |
| 1148 | containing objects which should be pushed to the remote. |
| 1149 | </p> |
| 1150 | <div class="paragraph"><p>Especially useful for interoperability with a foreign versioning |
| 1151 | system.</p></div> |
| 1152 | <div class="paragraph"><p>The <em>export-marks</em> and <em>import-marks</em> capabilities, if specified, |
| 1153 | affect this command in so far as they are passed on to <em>git |
| 1154 | fast-export</em>, which then will load/store a table of marks for |
| 1155 | local objects. This can be used to implement for incremental |
| 1156 | operations.</p></div> |
| 1157 | <div class="paragraph"><p>Supported if the helper has the "export" capability.</p></div> |
| 1158 | </dd> |
| 1159 | <dt class="hdlist1"> |
| 1160 | <em>connect</em> <service> |
| 1161 | </dt> |
| 1162 | <dd> |
| 1163 | <p> |
| 1164 | Connects to given service. Standard input and standard output |
| 1165 | of helper are connected to specified service (git prefix is |
| 1166 | included in service name so e.g. fetching uses <em>git-upload-pack</em> |
| 1167 | as service) on remote side. Valid replies to this command are |
| 1168 | empty line (connection established), <em>fallback</em> (no smart |
| 1169 | transport support, fall back to dumb transports) and just |
| 1170 | exiting with error message printed (can’t connect, don’t |
| 1171 | bother trying to fall back). After line feed terminating the |
| 1172 | positive (empty) response, the output of service starts. After |
| 1173 | the connection ends, the remote helper exits. |
| 1174 | </p> |
| 1175 | <div class="paragraph"><p>Supported if the helper has the "connect" capability.</p></div> |
| 1176 | </dd> |
| 1177 | </dl></div> |
| 1178 | <div class="paragraph"><p>If a fatal error occurs, the program writes the error message to |
| 1179 | stderr and exits. The caller should expect that a suitable error |
| 1180 | message has been printed if the child closes the connection without |
| 1181 | completing a valid response for the current command.</p></div> |
| 1182 | <div class="paragraph"><p>Additional commands may be supported, as may be determined from |
| 1183 | capabilities reported by the helper.</p></div> |
| 1184 | </div> |
| 1185 | </div> |
| 1186 | <div class="sect1"> |
| 1187 | <h2 id="_ref_list_attributes">REF LIST ATTRIBUTES</h2> |
| 1188 | <div class="sectionbody"> |
| 1189 | <div class="paragraph"><p>The <em>list</em> command produces a list of refs in which each ref |
| 1190 | may be followed by a list of attributes. The following ref list |
| 1191 | attributes are defined.</p></div> |
| 1192 | <div class="dlist"><dl> |
| 1193 | <dt class="hdlist1"> |
| 1194 | <em>unchanged</em> |
| 1195 | </dt> |
| 1196 | <dd> |
| 1197 | <p> |
| 1198 | This ref is unchanged since the last import or fetch, although |
| 1199 | the helper cannot necessarily determine what value that produced. |
| 1200 | </p> |
| 1201 | </dd> |
| 1202 | </dl></div> |
| 1203 | </div> |
| 1204 | </div> |
| 1205 | <div class="sect1"> |
| 1206 | <h2 id="_options">OPTIONS</h2> |
| 1207 | <div class="sectionbody"> |
| 1208 | <div class="paragraph"><p>The following options are defined and (under suitable circumstances) |
| 1209 | set by Git if the remote helper has the <em>option</em> capability.</p></div> |
| 1210 | <div class="dlist"><dl> |
| 1211 | <dt class="hdlist1"> |
| 1212 | <em>option verbosity</em> <n> |
| 1213 | </dt> |
| 1214 | <dd> |
| 1215 | <p> |
| 1216 | Changes the verbosity of messages displayed by the helper. |
| 1217 | A value of 0 for <n> means that processes operate |
| 1218 | quietly, and the helper produces only error output. |
| 1219 | 1 is the default level of verbosity, and higher values |
| 1220 | of <n> correspond to the number of -v flags passed on the |
| 1221 | command line. |
| 1222 | </p> |
| 1223 | </dd> |
| 1224 | <dt class="hdlist1"> |
| 1225 | <em>option progress</em> {<em>true</em>|<em>false</em>} |
| 1226 | </dt> |
| 1227 | <dd> |
| 1228 | <p> |
| 1229 | Enables (or disables) progress messages displayed by the |
| 1230 | transport helper during a command. |
| 1231 | </p> |
| 1232 | </dd> |
| 1233 | <dt class="hdlist1"> |
| 1234 | <em>option depth</em> <depth> |
| 1235 | </dt> |
| 1236 | <dd> |
| 1237 | <p> |
| 1238 | Deepens the history of a shallow repository. |
| 1239 | </p> |
| 1240 | </dd> |
| 1241 | <dt class="hdlist1"> |
| 1242 | <em>option followtags</em> {<em>true</em>|<em>false</em>} |
| 1243 | </dt> |
| 1244 | <dd> |
| 1245 | <p> |
| 1246 | If enabled the helper should automatically fetch annotated |
| 1247 | tag objects if the object the tag points at was transferred |
| 1248 | during the fetch command. If the tag is not fetched by |
| 1249 | the helper a second fetch command will usually be sent to |
| 1250 | ask for the tag specifically. Some helpers may be able to |
| 1251 | use this option to avoid a second network connection. |
| 1252 | </p> |
| 1253 | </dd> |
| 1254 | </dl></div> |
| 1255 | <div class="paragraph"><p><em>option dry-run</em> {<em>true</em>|<em>false</em>}: |
| 1256 | If true, pretend the operation completed successfully, |
| 1257 | but don’t actually change any repository data. For most |
| 1258 | helpers this only applies to the <em>push</em>, if supported.</p></div> |
| 1259 | <div class="dlist"><dl> |
| 1260 | <dt class="hdlist1"> |
| 1261 | <em>option servpath <c-style-quoted-path></em> |
| 1262 | </dt> |
| 1263 | <dd> |
| 1264 | <p> |
| 1265 | Sets service path (--upload-pack, --receive-pack etc.) for |
| 1266 | next connect. Remote helper may support this option, but |
| 1267 | must not rely on this option being set before |
| 1268 | connect request occurs. |
| 1269 | </p> |
| 1270 | </dd> |
| 1271 | </dl></div> |
| 1272 | </div> |
| 1273 | </div> |
| 1274 | <div class="sect1"> |
| 1275 | <h2 id="_see_also">SEE ALSO</h2> |
| 1276 | <div class="sectionbody"> |
| 1277 | <div class="paragraph"><p><a href="git-remote.html">git-remote(1)</a></p></div> |
| 1278 | <div class="paragraph"><p><a href="git-remote-testgit.html">git-remote-testgit(1)</a></p></div> |
| 1279 | </div> |
| 1280 | </div> |
| 1281 | <div class="sect1"> |
| 1282 | <h2 id="_git">GIT</h2> |
| 1283 | <div class="sectionbody"> |
| 1284 | <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> |
| 1285 | </div> |
| 1286 | </div> |
| 1287 | </div> |
| 1288 | <div id="footnotes"><hr /></div> |
| 1289 | <div id="footer"> |
| 1290 | <div id="footer-text"> |
| Junio C Hamano | 683a861 | 2013-08-23 20:50:09 | [diff] [blame] | 1291 | Last updated 2013-08-20 08:40:27 PDT |
| Junio C Hamano | b5e079f | 2013-02-08 00:02:52 | [diff] [blame] | 1292 | </div> |
| 1293 | </div> |
| 1294 | </body> |
| 1295 | </html> |
